Edit Task: SatelliteOrbitOptions
Description
The SatelliteOrbitOptions attribute under EditTask defines various orbit options for all associated satellites of this task.
Parameters
| Parameter | Description |
|---|---|
| OrbitLineColor | The color STK will use to draw the orbit lines for the associated satellites of this task.
Either the name of a color (listed in _Default.ap STK file), or four ARGB (Alpha Red Green Blue) values that are bytes (0-255) to represent orbit line color. |
| UseColor | A Boolean value. If true, the selected color will be used. |
| OrbitLineWidth | A double between 1.0 and 10.0 that will be used as the line width of the orbit lines for the associated satellites of this task. |
| UseWidth | A Boolean value. If true, the selected width will be used. |
| DisplayTaskId | A Boolean value. If true, the Task ID will be displayed by the orbit lines of the satellites associated with this task. |
| DisplayTaskStartTime | A Boolean value. If true, the Task Start Time will be displayed by the orbit lines of the satellites associated with this task. |
| DisplayTaskStopTime | A Boolean value. If true, the Task Stop Time will be displayed by the orbit lines of the satellites associated with this task. |
Examples
Set all values for satellite orbit options on the Maneuver task.
PATCH api/task/Maneuver
Body:
{
"SatelliteOrbitOptions" : {
"OrbitLineColor" : "255,0,255,255},
"UseColor" : "TRUE",
"OrbitLineWidth" : "3",
"UseWidth" : "TRUE'
"DisplayTaskId" : "TRUE",
"DisplayTaskStartTime" : "FALSE",
"DisplayTaskStopTime" : "FALSE" }
}
